com.inscoper.nbo.PinholeSettings

Represents the XML element PinholeSettings. More...

Inherits from com.inscoper.nbo.OpticalApertureSettings_Type, com.inscoper.nbo.Settings_Type, com.inscoper.nbo.Reference_Type, com.inscoper.nbo.NBOBaseClass

Public Functions

	Name
synchronized void	delete()
	PinholeSettings()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setAperture(float value, boolean validate) Sets the value of the Aperture attribute.
void	setAperture(float value) Sets the value of the Aperture attribute.
float	getAperture() Returns the value of the Aperture attribute.
void	resetAperture() Resets the Aperture attribute to an unset state.
boolean	hasAperture() Checks whether the Aperture attribute is present.
PinholeSettings	__internal_create(long cPtr, boolean own)
PinholeSettings	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions

	Name
	PinholeSettings(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(PinholeSettings obj)

Additional inherited members

Public Functions inherited from com.inscoper.nbo.OpticalApertureSettings_Type

	Name
	OpticalApertureSettings_Type()
void	setID(OpticalApertureID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(OpticalApertureID_Type value) Sets the value of the ID attribute.
OpticalApertureID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value, boolean validate) Sets the list of TransmittanceProfileFile elements.
void	setTransmittanceProfileFile_List(TransmittanceProfileFileVector value) Sets the list of TransmittanceProfileFile elements.
TransmittanceProfileFileVector	getTransmittanceProfileFile_List() Returns the list of TransmittanceProfileFile elements.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value, boolean validate) Adds a new TransmittanceProfileFile element to this object.
void	addToTransmittanceProfileFile_List(TransmittanceProfileFile value) Adds a new TransmittanceProfileFile element to this object.
void	clearTransmittanceProfileFile_List() Clear the list of TransmittanceProfileFile.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value, boolean validate) Sets the list of ReflectanceProfileFile elements.
void	setReflectanceProfileFile_List(ReflectanceProfileFileVector value) Sets the list of ReflectanceProfileFile elements.
ReflectanceProfileFileVector	getReflectanceProfileFile_List() Returns the list of ReflectanceProfileFile elements.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value, boolean validate) Adds a new ReflectanceProfileFile element to this object.
void	addToReflectanceProfileFile_List(ReflectanceProfileFile value) Adds a new ReflectanceProfileFile element to this object.
void	clearReflectanceProfileFile_List() Clear the list of ReflectanceProfileFile.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value, boolean validate) Sets the list of TransmissionWavelengthRangeSettings elements.
void	setTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettingsVector value) Sets the list of TransmissionWavelengthRangeSettings elements.
TransmissionWavelengthRangeSettingsVector	getTransmissionWavelengthRangeSettings_List() Returns the list of TransmissionWavelengthRangeSettings elements.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value, boolean validate) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	addToTransmissionWavelengthRangeSettings_List(TransmissionWavelengthRangeSettings value) Adds a new TransmissionWavelengthRangeSettings element to this object.
void	clearTransmissionWavelengthRangeSettings_List() Clear the list of TransmissionWavelengthRangeSettings.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value, boolean validate) Sets the list of ReflectionWavelengthRangeSettings elements.
void	setReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettingsVector value) Sets the list of ReflectionWavelengthRangeSettings elements.
ReflectionWavelengthRangeSettingsVector	getReflectionWavelengthRangeSettings_List() Returns the list of ReflectionWavelengthRangeSettings elements.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value, boolean validate) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	addToReflectionWavelengthRangeSettings_List(ReflectionWavelengthRangeSettings value) Adds a new ReflectionWavelengthRangeSettings element to this object.
void	clearReflectionWavelengthRangeSettings_List() Clear the list of ReflectionWavelengthRangeSettings.

Protected Functions inherited from com.inscoper.nbo.OpticalApertureSettings_Type

	Name
	OpticalApertureSettings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type()
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.

Protected Functions inherited from com.inscoper.nbo.Settings_Type

	Name
	Settings_Type(long cPtr, boolean cMemoryOwn)

Public Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type()

Protected Functions inherited from com.inscoper.nbo.Reference_Type

	Name
	Reference_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description

public class com.inscoper.nbo.PinholeSettings;

Represents the XML element PinholeSettings.

This element holds the Setting applied to a Pinhole used during the Acquisition of this Channel as well as a reference (the ID attribute) to the Pinhole in question.

Public Functions Documentation

function delete

public synchronized void delete()

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.delete

function PinholeSettings

public PinholeSettings()

function getTypeName

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.getTypeName

function getXMLName

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.getXMLName

function getNBOType

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.getNBOType

function getChildren

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.getChildren

function getSubElements

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.getSubElements

function fromJsonFile

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromJsonFile

function fromJsonFile

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

• path The path to the JSON file

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromJsonFile

function fromJsonString

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromJsonString

function fromJsonString

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

• json_string The JSON content as a string

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromJsonString

function fromXmlFile

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromXmlFile

function fromXmlFile

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

• path The path to the XML file

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromXmlFile

function fromXmlString

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromXmlString

function fromXmlString

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

• xml_string The XML content as a string

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromXmlString

function toXmlFile

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file
• validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.toXmlFile

function toXmlFile

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

• filename The path to the output XML file

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.toXmlFile

function toXmlString

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

• validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.toXmlString

function toXmlString

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.toXmlString

function setAperture

public void setAperture(
    float value,
    boolean validate
)

Sets the value of the Aperture attribute.

Parameters:

• value The value to set
• validate If true, validates constraints on value. Default is true.

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

function setAperture

public void setAperture(
    float value
)

Sets the value of the Aperture attribute.

Parameters:

• value The value to set

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

function getAperture

public float getAperture()

Returns the value of the Aperture attribute.

Return: The value of the attribute

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

function resetAperture

public void resetAperture()

Resets the Aperture attribute to an unset state.

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

function hasAperture

public boolean hasAperture()

Checks whether the Aperture attribute is present.

Return: true if the attribute has been set, false otherwise

This refers to the Diameter of the Pin Hole's Aperture that was set for this Acquisition, expressed in Airy units.

function __internal_create

public static PinholeSettings __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.__internal_create

function fromBase

public static PinholeSettings fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

• base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.fromBase

Protected Functions Documentation

function PinholeSettings

protected PinholeSettings(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.swigSetCMemOwn

function finalize

protected void finalize()

Reimplements: com.inscoper.nbo.OpticalApertureSettings_Type.finalize

function getCPtr

protected static long getCPtr(
    PinholeSettings obj
)

---

Updated on 2026-06-22 at 17:06:31 +0200